home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 013 / diskcat.arc / DISKCAT.DOC < prev    next >
Encoding:
Text File  |  1985-11-10  |  12.5 KB  |  301 lines
  1.                          DISKCAT v.2.0
  2.                       Disk Catalog Program
  3.  
  4. Programs-  DISKCAT.EXE  uses a machine language routine to read a disk's
  5.              directory, adds file names, date and size to a catalog file,
  6.              allows file descriptions to be added, searches for file and
  7.              disk names, gives a disk its own table of contents file, and
  8.              more.
  9.            DC-SORT.EXE  sorts, prints the catalog file; it will compare two
  10.              catalog files and print a comparative list showing differences.
  11.            DC-FIND.EXE  from DOS, displays the disk name for a specified file.
  12.            DC-O.EXE, DC-S-O.EXE, DC-F-O.EXE are versions of the above programs
  13.              compiled with the "/O" option. If you do not have the compiler
  14.              run-time program, BASRUN.EXE, use these versions. You should
  15.              first rename them as DISKCAT.EXE, DC-SORT.EXE, and DC-FIND.EXE.
  16.  
  17. Hardware Requirements-
  18.      Minimum:  96K, one disk drive, 80-column monitor, IBM PC or Compaq.
  19.      Recommended:  a RAM disk-emulator to hold DISKCAT.DTA, printer,
  20.                    graphics board,  BASRUN.EXE.
  21.      DOS:  1.0  1.1  2.0
  22.  
  23. Maximum # of file name entries:  2000 to 4000+ depending on memory. (For more
  24.      than 2000 entries, you must modify the DIM statements in DC-SORT.BAS.)
  25.  
  26.  
  27. DISKCAT.EXE Program Functions-
  28.  
  29. 1)  Read a disk's files into the catalog.
  30.       -prompts for a name for the disk
  31.       -checks to see if name is already used and, if so, choices are to
  32.          * delete the disk from the file
  33.              Records to be deleted are changed to all z's.  Select "Purge"
  34.              at main menu to remove these records.  After marking records
  35.              for deletion, you are prompted again for a disk name.  If you
  36.              just wanted to delete the disk without reading another one,
  37.              press Enter and return to main menu.
  38.          * read the disk and update the file
  39.              This option allows you to update a disk's records without
  40.              wiping out the file descriptions for files that are still on
  41.              the disk.  See "2)  Add descriptions to file names".
  42.          * enter another disk name
  43.       -file names, size & date are read from disk, sorted by name and
  44.          added to DISKCAT.DTA file. The disk name is added to DISKCAT.NFO
  45.          along with disk type (# sides, # sectors) and free space remaining.
  46.  
  47. 2)  Add descriptions to file names.
  48.       -displays disk name and file name and prompts for a 10-character
  49.          category and 25-character file description.   The displayed
  50.          categories can be entered into the category field by entering the
  51.          number or first few characters of the category name.
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                               page 1 
  61.       -the following functions are available in this routine:
  62.         [Alt]-
  63.          [P] Prior entry:  displays previous entry.
  64.          [F] Find file:  finds a file from all or part of the name
  65.                            and makes it the current record.
  66.          [D] Find disk:  finds a disk from all or part of the name,
  67.                            and makes the first file on the disk the
  68.                            current record.
  69.          [K] Kill entry: marks the displayed entry for deletion by
  70.                            the "Purge" routine. Also allows the file
  71.                            to actually be deleted from the disk.
  72.          [V] View file:  displays contents of a file one screen at a time,
  73.                            which is useful when entering file descriptions.
  74.          [R] Repeat entry:  repeats category & description from previous
  75.                            file: for programs with multiple files, such as
  76.                            FK.DOC, FK.HEX, FK.COM.
  77.          [S] Skip disk:  finds the next disk name and makes its first file
  78.                            the current record.
  79.          [C] Edit categories:  allows you to change the category names.
  80.  
  81. 3)  Give a disk its own catalog.
  82.       -creates a file on the target disk of its files with descriptions.
  83.          The file can be TYPEd from DOS to review contents of disk.
  84.  
  85. 4)  Find all copies of one file.
  86.       -displays all disk names containing the desired file.
  87.  
  88. 5)  Display all files for a disk name.
  89.  
  90. 6)  Display all disk names along with # sectors, # sides and free space.
  91.  
  92. 7)  Print a hardcopy catalog listing.
  93.       -goes to the DC-SORT program to print the DISKCAT.DTA file.
  94.  
  95. 8)  Purge deleted files from catalog.
  96.       -eliminates records marked for deletion with z's.
  97.       -NOTE: compressing records in a random access file does not change the
  98.        physical size of the file, even though a new End-of-file marker is used.
  99.        The problem is that the file size in the directory is not changed yet.
  100.        To change the file size, either copy DISKCAT.DTA in DOS using /A, which
  101.        will cause DOS to stop at the EOF marker, or use the print-to-file
  102.        option in DC-SORT to create a new file (see DC-SORT Functions, below).
  103.  
  104.  
  105. DC-DOC.BAS  &  DISKCAT.DOC
  106.  
  107.         DC-DOC.BAS contains an introduction to DISKCAT and will print the
  108. DISKCAT.DOC documentation file to the screen or printer.  DISKCAT.DOC can also
  109. be TYPEd from DOS.  DC-DOC.BAS does not come compiled and is the only program
  110. in this series that may be passed around in a source-code format.
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.                               page 2 
  121. DC-SORT.EXE Program Functions-
  122.  
  123. 1)  Compare two DISKCAT.DTA files.
  124.       -compares two catalogs and prints a comparative list.  This function
  125.        is designed to facilitate comparing software libraries by different
  126.        user groups or individuals who collect public domain software.
  127.  
  128. 2)  Print DISKCAT.DTA sorted by file name.
  129.       -this option and the ones that follow will print to the screen,
  130.        the printer, or a disk file.
  131.  
  132. 3)  Print DISKCAT.DTA sorted by disk name.
  133.       -this option and the ones that follow first sort by file name,
  134.        then by the option selected; in this case, by disk name.
  135.  
  136. 4)  Print DISKCAT.DTA sorted by file type.
  137.  
  138. 5)  Print DISKCAT.DTA sorted by file extension.
  139.  
  140.  
  141.  
  142. Data Files-
  143.  
  144. 1)  DISKCAT.DTA is a random access file containing file names & info.
  145.       Record layout:
  146.           file name        12 spaces
  147.           disk name         8 spaces
  148.           file type        10 spaces
  149.           file descrip.    25 spaces
  150.           file date        10 spaces
  151.           file size         7 spaces
  152.           carriage rtn
  153.             & line feed     2 spaces  (Allows TYPEing DISKCAT.DTA at DOS or
  154.                            --          loading it into a word processor.)
  155.           record length    74
  156.  
  157. 2)  DISKCAT.NFO is a sequential file that, when you first receive it, contains
  158.       the file categories (see below). When you name a disk and read its files,
  159.       the disk name and total number of file names in DISKCAT.DTA is added to
  160.       this file.  When starting a new DISKCAT.DTA file, copy the file
  161.       DC-NEW.NFO  to  DISKCAT.NFO.
  162.  
  163.  
  164. OTHER WAYS TO EDIT AND PRINT THE CATALOG-
  165.  
  166. The DISKCAT.DTA file can be TYPEd from DOS.  It can also be edited by text
  167. processors, with the following warnings:
  168.   -IBM's Personal Editor should be used with the NOTABS option when saving.
  169.      Otherwise, it replaces blanks with tabs, which destroys the necessary
  170.      uniform record length.
  171.   -WordStar can be used in the non-document mode, but be careful to enter
  172.      data exactly as in the other records. (eg: the dot [.] in the file
  173.      name must always be in column 9).
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.                                 page 3 
  181.   -NOTE: if records are added or deleted with text processors, the number
  182.      of files (the second number in the DISKCAT.NFO file) must be changed.
  183.   -You should use text processors only if the file has been messed up and
  184.      you are trying to save it.  All lines must be 72 characters long,
  185.      followed with a carriage return & line feed.
  186.  
  187. The data base program, PC-FILE, that is available from most user groups,
  188.   can be used for special printing or sorting requirements.  First, you
  189.   must use PC-FILE to set up the DISKCAT.HDR file, using the field lengths
  190.   shown at the start of this documentation. You must include a 1-character
  191.   field for the line feed, even though you would not print that field. The
  192.   carriage return is PC-FILE's "end-of-record" marker, but is not a field.
  193.   You must then use PC-FILE to sort DISKCAT.DTA so that PC-FILE will create
  194.   an index file for its own use.
  195.  
  196.  
  197. SUGGESTIONS-
  198.  
  199. As already mentioned, this program makes it easy for PC user groups to
  200. catalog and describe their public domain software libraries and to compare
  201. them with other groups.  Because disks can be read so quickly, libraries
  202. of over 1000 files each can be read and compared in a matter of minutes.
  203.  
  204. I have a hard disk that I back up on floppies.  By keeping this program on
  205. the hard disk, I can find in seconds which floppy contains the backup copy
  206. of a particular file. For this use, since I usually know what the files are,
  207. I don't bother to enter file descriptions. Having a printout of DISKCAT.DTA
  208. sorted by filename is handy when it is not convenient to load DISKCAT.
  209.  
  210. When entering descriptions, viewing the contents of the file is very helpful.
  211. Most of an .EXE file will print out as gibberish, but it might have enough
  212. string data that will print out as text to aid in classifying a file. Use
  213.  
  214.  
  215. ASSIGNING CATEGORIES-
  216.  
  217. The Category is meant to be a "key field" that you can use to group files
  218. in a printout.  Let's say you are classifying the DISKCAT program.
  219. For Category, you could call DISKCAT.EXE a "Disk catalog" file , the .DOC
  220. file a"Documentation" file, the .DTA file a "Data file".  But when you sort
  221. by Category, do you really want to see all the documentation files listed
  222. by themselves and all the data files by themselves?  I prefer to classify
  223. all related files the same as the main program, so that they will be grouped
  224. together when printing a list sorted by Category.
  225.  
  226. Try to use the Categories displayed at the top of the screen so that the
  227. descriptions that are meant to be the same will match exactly. Otherwise,the
  228. sort program will not recognize them as being the same.  The Categories can
  229. be changed in the DISKCAT.NFO file with a word processor. The maximum number
  230. of categories is 32.  If adding or deleting categories, be sure to change
  231. the amount following the words "Number of Categories" in the DISKCAT.NFO file.
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.                                 page 4 
  241. In the Houston user's group, we put similar files onto the same disk and
  242. give the disk an appropriate name, such as UTILITIES.  This allows us to be
  243. more specific in naming the Utilities, such as function-key utilities,
  244. sort utilities, etc., since the disk name already indicates what general
  245. category the file fits into.
  246.  
  247.  
  248. DISTRIBUTION-
  249.  
  250. A limited license is granted to copy the compiled versions of DISKCAT,
  251. DC-SORT and DC-FIND and associated files except the BASIC source code
  252. of the three programs just mentioned. All copyright notices must be left
  253. intact and this documentation file included. In addition, these programs
  254. are not to be distributed as part of any commercial endevour, such as, but
  255. not limited to, software give-aways by retailers, "magazines-on-a-disk", or
  256. groups that charge more than a nominal "copying fee" for a disk with these
  257. files.  The programs, excluding the uncompiled BASIC programs, may be
  258. included on all electronic bulletin boards and PC user group libraries.
  259.  
  260. These programs are being distributed under the pay-only-if-you-like-it
  261. approach. The suggested contribution is $20.
  262.  
  263.  
  264. SOURCE CODE-
  265.  
  266. The source code will be sent to paying customers only.  The source code
  267. for DISKCAT may not be copied and distributed.  Potential users should be
  268. able to tell from using the compiled programs whether they like them.  If
  269. they like them enough to want the source code, they can order it for $20.
  270.  
  271. If you make modifications or have suggestions for improvements, I am very
  272. interested in hearing of them.
  273.  
  274.  
  275.  
  276. Nelson Ford
  277. P.O. Box 61565
  278. Houston, Texas 77208
  279.  
  280. Source ID:  ST3564
  281. ------------------
  282.  
  283. Acknowledgements for Suggestions:
  284. (1) Kill file from disk when deleting entry from DISKCAT.
  285. (2) Show free space on disk along with file name.
  286.     (James Jacques    Delafield,WI)
  287.  
  288. (3) Show disk type (# sectors and # sides) along with file name.
  289.     (Bob Duval   Charleston, SC)
  290.  
  291. (4) Include DISKCAT.HDR file for easier use with PC-FILE (copyright J.Button).
  292. (5) Read DOS 2.0 subdirectories (future enhancement).
  293.     (John Burns    Mattawan, MI)
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.                              page 5 
  301.